home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr33 / datein11.zip / DATEINFO.DOC next >
Text File  |  1993-06-07  |  17KB  |  463 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8. ===============================================================================                    
  9.  
  10.  
  11.                     Date Infominder v1.1  (Shareware Version)
  12.              (C) Copyright 1993 ARAD Software.  All Rights Reserved.
  13.                         Programmed by Brian Gugliemetti.
  14.  
  15.  
  16. ===============================================================================
  17.  
  18.  
  19.  
  20.  
  21.                   *  T A B L E    O F    C O N T E N T S  *
  22.  
  23.  
  24.         I.  Purpose of Date Infominder................................1
  25.        II.  Setting Up Date Infominder and Requirements...............1
  26.       III.  How Date Infominder Works.................................2
  27.        IV.  Adding/Editing Events.....................................2
  28.         V.  Deleting Events...........................................3
  29.        VI.  Printing Events for a Month...............................3
  30.       VII.  Saving Event Files........................................3
  31.      VIII.  Exiting Date Infominder...................................3
  32.        IX.  Inquiring for Events......................................3
  33.         X.  Command Line Parameters...................................4
  34.        XI.  Using Date Infominder with Windows........................5
  35.       XII.  Special Notes about Date Infominder.......................5
  36.      XIII.  Registering Date Infominder...............................6
  37.       XIV.  Contacting the Author.....................................6
  38.        XV.  Disclaimer................................................6
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.                                     - i -                Date Infominder v1.1
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.    I.  Purpose of Date Infominder
  76.    ------------------------------
  77.  
  78.    Date Infominder was created to help recall important dates, such as
  79.    birthdays and upcoming events.  It's main purpose is to be used in the
  80.    AUTOEXEC.BAT or Windows' Startup so that each time you turn on your
  81.    computer, any events which you want to be notified of appear on screen.
  82.  
  83.  
  84.    II.  Setting up Date Infominder and Requirements
  85.    ------------------------------------------------
  86.  
  87.    In order to run Date Infominder, you will need DOS 3.3 or higher, at least 
  88.    192k of free memory, an IBM compatible (8086+ processor), around 100,000 
  89.    bytes free disk space, and an EGA or better video card.  Date Infominder 
  90.    does not require the use of a hard drive, but it is strongly recommended for 
  91.    speed.  Date Infominder supports the use of a Microsoft compatible mouse.
  92.  
  93.    When you first run Date Infominder, after the title screen appears,
  94.    a box will appear which says "EVENTS.DAT File not found.  Create new
  95.    one (Y/n)?"  Date Infominder defaults to the current directory for the
  96.    event file, so if that is not where you want to file to be created, change
  97.    to another directory and rerun the program.  If you are in the desired
  98.    directory, answer yes or hit return.  It is recommended at you keep both
  99.    the DATEINFO.EXE and event file in the same directory.
  100.  
  101.    Select "Configure" from the main screen and answer yes.  Specify the full
  102.    path where the event file is found, i.e. C:\DOS.  Date Infominder defaults
  103.    to LPT1.  If you wish to change to LPT2, in the configure screen, press
  104.    the TAB key to move to the printer port area, then press the space bar
  105.    to toggle the printer port.  When you are satisfied with the configuration,
  106.    hit return to save.
  107.  
  108.    Note: The Configure option is disabled when you override the event file.
  109.  
  110.    If you see "Could not locate DATEINFO.EXE, configuration not saved", it
  111.    means that the program could not find DATEINFO.EXE in the default directory,
  112.    thus no changes were saved.  Make sure you are in the same directory as
  113.    DATEINFO.EXE before configuring.  Also, do not rename DATEINFO.EXE to any
  114.    other name.  The program searches for it when it saves the new configuration.
  115.  
  116.    If you see "Fatal error:  Could not write to DATEINFO.EXE" it most likely
  117.    means that the write protect is on.  Date Infominder will override the
  118.    read only attribute on itself when it saves the configuration, so under
  119.    normal circumstances you shouldn't see this message.
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.                                     - 1 -                Date Infominder v1.1
  128.    
  129.    
  130.    
  131.    
  132.    
  133.    
  134.    
  135.    
  136.    
  137.    III.  How Date Infominder Works
  138.    -------------------------------
  139.  
  140.    Date Infominder uses a perennial system, which means it is not year
  141.    dependent for events.  (i.e. You can't specify to be notified of an event
  142.    on March 6, 1996.  You can only specify to be notified on March 6th.)
  143.    The user specifies the events for the year that he/she wants to be notified
  144.    of.  For the events, the user selects a notification period which tells
  145.    how far in advance the user is notified of the event.  When the program
  146.    is run in the inquiry mode, it reads the computers internal calendar,
  147.    checks for events which are within the notification range, displays those
  148.    events, and then exits.  If no events are found, it displays "No 
  149.    notifications."
  150.  
  151.    When in the editing mode, Date Infominder again reads the internal calendar
  152.    and displays the edited month accordingly.  If the selected month is the
  153.    current month or in the future, it displays the calendar as it appears for
  154.    that year.  If the selected month has already passed, it displays the
  155.    calendar as it appears next year.  Example:  The current date is 5/6/93.
  156.    You select June to edit.  The program displays the month of June formatted
  157.    to calendar year 1993.  Afterwards, you select April to edit.  The program
  158.    displays the month of April formatted to calendar year 1994.  This allows
  159.    you to see which day of the week the event will fall upon the next time it 
  160.    arrives.  The calendar year for the month displayed is in the upper right
  161.    hand corner of the edit screen.  This is just a point of reference for the
  162.    user and does not indicate that events are being defined for that year.
  163.  
  164.    Date Infominder can hold up to 300 events with a maximum description length
  165.    of 400 characters.  The totaled description lengths must be under 65,535
  166.    characters.  If the totaled lengths go over 65,535, the program will not
  167.    allow any more events to be defined.
  168.  
  169.  
  170.    IV.  Adding/Editing Events
  171.    --------------------------
  172.  
  173.    You need to use the editing mode of the program, which means you do not
  174.    use the "/I" command line parameter.  From the main selection screen, you
  175.    need to select edit (ALT-E).  Choose a month using the mouse or keyboard.
  176.    The edit screen should come up and display the month selected.  Use the
  177.    cursor keys or mouse to select the day to edit.  If the day has a predefined
  178.    event, you will see the description in the event description box near the
  179.    bottom of the screen and the notification period in the box to the right of
  180.    the screen.  If you wish to edit the day, simply hit return or click on the
  181.    left mouse button.  The cursor will appear in the event description box.
  182.    Type in the description of the event.  (The event editor has automatic 
  183.    word-wrapping.  It allows a maximum description length of 400 characters.)
  184.    When done with the description, hit the F5 key.  Selector arrows should
  185.    appear in the notification box.  Again, use the cursor keys or the mouse
  186.    to select the notification period.  Either click the left mouse button or
  187.    hit return to complete the event definition.  If you wish to go back and
  188.    change the description, hit the ESC key.  Then hit the F5 key again to
  189.    select the period.
  190.  
  191.  
  192.  
  193.                                     - 2 -                Date Infominder v1.1
  194.    
  195.    
  196.    
  197.    
  198.    
  199.    
  200.    
  201.    
  202.    
  203.    V.  Deleting Events
  204.    -------------------
  205.  
  206.    To delete events, select edit (ALT-E) from the main selection screen.  Next
  207.    choose the month in which the event you wish to delete falls.  Finally, 
  208.    select the day the event in on and press the DELETE key.  A box will appear 
  209.    asking if you really want to delete the event.  Answer yes to delete it or 
  210.    no to abort the delete.
  211.  
  212.  
  213.    VI.  Printing Events for a Month
  214.    --------------------------------
  215.  
  216.    First, select the Print option from the main selection screen (ALT-P),
  217.    and then choose the month you wish to print all events for.
  218.  
  219.    If you see "Error: Printer Not Ready", check to make sure the printer is
  220.    turned on and is on-line.  If it is, next check the default printer port in
  221.    the configure screen.  If both are set correctly, hit return to retry the
  222.    printer.  If the error continues, check your printer cable.
  223.  
  224.    Note:  If you used control codes in your event description, they will
  225.    be replaced with asterisks before being printed.
  226.  
  227.  
  228.    VII.  Saving Event Files
  229.    ------------------------
  230.  
  231.    To save the current event file, select the Save option from the main
  232.    selection screen (ALT-S), and answer yes.
  233.  
  234.  
  235.    VIII.  Exiting from Date Infominder
  236.    -----------------------------------
  237.  
  238.    To exit Date Infominder, select the Exit option from the main selection
  239.    screen (ALT-X), and answer yes.  If changes have been made to event file
  240.    and have not been saved, a warning message will appear asking if you wish
  241.    to save the changes before exiting.  Answer yes to save changes and exit,
  242.    or no to exit without saving.
  243.  
  244.  
  245.    IX.  Inquiring for Events
  246.    -------------------------
  247.  
  248.    To inquiry for events, use the "/I" command line parameter.
  249.    i.e. type "DATEINFO /I" at the C:\> prompt.  If any events are found,
  250.    it will display them on the screen.
  251.  
  252.    To print the events to the printer, type the following:
  253.    DATEINFO /I /S > PRN
  254.  
  255.  
  256.    
  257.    
  258.    
  259.                                     - 3 -                Date Infominder v1.1
  260.    
  261.    
  262.    
  263.    
  264.    
  265.    
  266.    
  267.    
  268.    X.  Command Line Parameters
  269.    ---------------------------
  270.  
  271.    Command line parameters are items that can be placed behind the program
  272.    name on the command line (C:\> prompt).  They allow certain functions to
  273.    be performed when the program is entered.  Date Infominder has four main
  274.    command line parameters.  They are as follows:
  275.  
  276.              DATEINFO [/I] [/P] [/S] [/E:[drive:][path]event file]
  277.  
  278.    The [] mean the command line parameter is optional.
  279.  
  280.    /I
  281.    --
  282.    /I puts Date Infominder into the inquiry mode.  It checks the event
  283.    file and displays any events which fall within the notification period.
  284.  
  285.    /P
  286.    --
  287.    /P causes Date Infominder to wait for a key to be hit before exiting
  288.    the program.  This option is only for inquiry mode; it is ignored by the
  289.    edit mode.  Windows users should use this option for the Inquiry icon of
  290.    Date Infominder.  (i.e.  [drive:][path] DATEINFO /I /P)
  291.  
  292.    /S
  293.    --
  294.    /S causes Date Infominder to write the events found during an inquiry
  295.    as strings.  This allows redirection of output.  You can print the events
  296.    to the printer by typing: DATEINFO /I /S > PRN
  297.  
  298.    /E
  299.    --
  300.    /E is used to specify an alternate event file.  This option can be used
  301.    for both the edit and inquiry modes.  You must specify the complete path
  302.    AND filename.  i.e. DATEINFO /E:C:\MISC\MYEVENTS.DAT
  303.    If the specified event file does not exist, the program will ask if you
  304.    wish to create the specified file.  Answer yes if the event file is a new
  305.    one, otherwise check the path and file name.
  306.  
  307.        Note:  When using the /E parameter, the configure option is disabled.
  308.               You can only configure when you use the default EVENTS.DAT file.
  309.               However, the printer port defined is used for all files.
  310.  
  311.    Examples:
  312.    ---------
  313.    DATEINFO /I /P
  314.    This will do an inquiry and ask for a key to be hit before exiting.
  315.  
  316.    DATEINFO /I /E:D:\OTHER.DAT
  317.    This will do an inquiry on the event file D:\OTHER.DAT
  318.  
  319.    DATEINFO /I /S > PRN
  320.    This is do an inquiry and print the results to the printer.
  321.  
  322.    DATEINFO /E:A:\MYEVENTS.DAT
  323.    This will use A:\MYEVENTS.DAT for the edit mode functions.  If the file
  324.    does not exist, the program will ask if you want it created.  When you
  325.    save, the events will be saved to this file.
  326.  
  327.                                     - 4 -                Date Infominder v1.1
  328.    
  329.    
  330.    
  331.    
  332.    
  333.  
  334.    XI.  Using Date Infominder with Windows
  335.    ---------------------------------------
  336.  
  337.    Included in DATEINFO.ZIP is DATEINFO.PIF.  This .PIF file should be copied
  338.    to your \WINDOWS directory.  This configures Windows to use a window for
  339.    Date Infominder.  You should set up two icons for Date Infominder; one for
  340.    the edit mode and another for inquiries.  For the inquiries icon, remember
  341.    to specify /I and /P as command line parameters.  You may want to create
  342.    a third icon for printing inquiries to the printer.  The command line for
  343.    that icon should be: DATEINFO /I /S > PRN
  344.  
  345.    Mouse support for Date Infominder is lost when used under Windows.
  346.  
  347.  
  348.    XII.  Special Notes about Date Infominder
  349.    -----------------------------------------
  350.  
  351.    Do NOT rename DATEINFO.EXE.  When you configure Date Infominder, it writes
  352.    the new configuration to DATEINFO.EXE.  If you rename the file, it won't
  353.    be able to locate DATEINFO.EXE and save the new configuration.
  354.  
  355.    Do NOT use programs such as PKLITE, DIET, or other self-extracting .EXE
  356.    program creators.  When you configure Date Infominder, it writes the new
  357.    configuration to DATEINFO.EXE.  The offset in the file where the 
  358.    configuration is stored will be changed after using one of the above 
  359.    programs and Date Infominder will be corrupted.
  360.  
  361.    Date Infominder is written entirely in assembler.  Why?  Mostly to keep
  362.    my assembler skills intact.  Also, it generates compact code.  Finally,
  363.    I like to program in assembler! :)
  364.  
  365.    For those of you who are curious or would just like to program their own
  366.    inquiry handler, here is the file structure for the event files.
  367.  
  368.         HEADER {
  369.                 Start of free space in 64k description block  dw (?)
  370.                 RESERVED dw (?)
  371.         }  Totals 4 bytes.
  372.  
  373.         EVENT TABLE (repeated 300 times, kept in month/day ascending order) {
  374.                 Month   db (?)
  375.                 Day     db (?)
  376.                 Notification status  db (?)   <see table below for values>
  377.                 RESERVED db (?)
  378.                 RESERVED dw (?)
  379.                 description displacement in 64k description block dw (?)
  380.         }  Totals 8 bytes*300=2400 bytes.
  381.  
  382.         EVENT DESCRIPTIONS (up to 65535 bytes, variable length.  Each
  383.                 description is an ASCIZ string.)
  384.  
  385.         Notification Status Table
  386.         -------------------------
  387.          0 - Same day                        30 - 1 month before
  388.          1 - 1 day before                    60 - 2 months before
  389.          5 - 5 days before                   90 - 3 months before
  390.          7 - 1 week before                  180 - 6 months before
  391.         14 - 2 weeks before
  392.  
  393.                                     - 5 -                Date Infominder v1.1
  394.    
  395.    
  396.  
  397.    
  398.    
  399.    
  400.    
  401.    XIII.  Registering Date Infominder
  402.    ----------------------------------
  403.  
  404.    Date Infominder is shareware.  If you use it beyond a 21 day trial period,
  405.    you must register.  Registration is $15 (US$).  Include $5 extra if you
  406.    wish to receive the lastest version along with a printed manual.  (Foreign
  407.    orders include $10 extra for S&H.)  Please specify 3 1/2" or 5 1/4" DD/HD
  408.    diskette.  Print out DI_ORDER.FRM and mail to the specified address to
  409.    register.  All funds must be in US currency.  Checks and money orders only.
  410.  
  411.    You may distribute this file to your friends and BBS' as long as all files
  412.    are included and none of the files are modified.
  413.  
  414.  
  415.    XIV.  Contacting the Author
  416.    ---------------------------
  417.  
  418.    If you have questions, comments, or bug reports, please contact me at
  419.    one of the following addresses:
  420.  
  421.         CompuServe  71754,2237
  422.         
  423.         Internet    BGUGLIE@HOLONET.NET
  424.         
  425.         U.S. Mail   Brian Gugliemetti
  426.                     c/o ARAD Software
  427.                     5011 Fletcher Place
  428.                     Rockford, IL 61108-4171
  429.  
  430.    I've tried to test the program thoroughly, but I can't guarantee all of
  431.    the bugs were caught.  If you find a bug, report what you were doing when
  432.    it happened, and the results of the bug.
  433.  
  434.  
  435.    XV.  Disclaimer
  436.    ---------------
  437.  
  438.    ARAD Software is not liable for any problems that you may incur while using
  439.    Date Infominder.  This includes psychological and physiological problems.
  440.    :-)  (Not that any should arise!)  You agree to the terms of this disclaimer
  441.    and use the program at your own risk.
  442.  
  443.  
  444.    Special thanks goes to David Puckett for his suggestions, encouragement,
  445.    and beta testing of version 1.1.
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.                                     - 6 -                Date Infominder v1.1
  458.  
  459.  
  460.  
  461.  
  462.  
  463.